<!--$Id: base_meth.so,v 1.5 2008/04/23 13:35:47 sue Exp $-->
<!--Copyright (c) 1997,2008 Oracle.  All rights reserved.-->
<!--See the file LICENSE for redistribution information.-->
<html>
<head>
<title>Berkeley DB Reference Guide: Base replication API</title>
<meta name="description" content="Berkeley DB: An embedded database programmatic toolkit.">
<meta name="keywords" content="embedded,database,programmatic,toolkit,btree,hash,hashing,transaction,transactions,locking,logging,access method,access methods,Java,C,C++">
</head>
<body bgcolor=white>
<table width="100%"><tr valign=top>
<td><b><dl><dt>Berkeley DB Reference Guide:<dd>Berkeley DB Replication</dl></b></td>
<td align=right><a href="../rep/mgr_meth.html"><img src="../../images/prev.gif" alt="Prev"></a><a href="../toc.html"><img src="../../images/ref.gif" alt="Ref"></a><a href="../rep/comm.html"><img src="../../images/next.gif" alt="Next"></a>
</td></tr></table>
<p align=center><b>Base replication API</b></p>
<p>Applications which use the Base replication API use the following
Berkeley DB methods.</p>
<br>
<b><a href="../../api_c/rep_transport.html">DB_ENV-&gt;rep_set_transport</a></b><ul compact><li>The <a href="../../api_c/rep_transport.html">DB_ENV-&gt;rep_set_transport</a> method configures the replication system's
communications infrastructure.</ul>
<b><a href="../../api_c/rep_start.html">DB_ENV-&gt;rep_start</a></b><ul compact><li>The <a href="../../api_c/rep_start.html">DB_ENV-&gt;rep_start</a> method configures (or reconfigures) an existing database
environment to be a replication master or client.</ul>
<b><a href="../../api_c/rep_message.html">DB_ENV-&gt;rep_process_message</a></b><ul compact><li>The <a href="../../api_c/rep_message.html">DB_ENV-&gt;rep_process_message</a> method is used to process incoming messages from other
environments in the replication group.  For clients, it is responsible
for accepting log records and updating the local databases based on
messages from the master.  For both the master and the clients, it is
responsible for handling administrative functions (for example, the
protocol for dealing with lost messages), and permitting new clients to
join an active replication group.  This method should only be called
after the environment has been configured as a replication master or
client via <a href="../../api_c/rep_start.html">DB_ENV-&gt;rep_start</a>.</ul>
<b><a href="../../api_c/rep_elect.html">DB_ENV-&gt;rep_elect</a></b><ul compact><li>The <a href="../../api_c/rep_elect.html">DB_ENV-&gt;rep_elect</a> method causes the replication group to elect a new
master; it is called whenever contact with the master is lost and the
application wants the remaining sites to select a new master.</ul>
<b><a href="../../api_c/env_event_notify.html">DB_ENV-&gt;set_event_notify</a></b><ul compact><li>The <a href="../../api_c/env_event_notify.html">DB_ENV-&gt;set_event_notify</a> method is needed for applications to
discover important replication-related events, such as the result of
an election and appointment of a new master.</ul>
<b><a href="../../api_c/rep_priority.html">DB_ENV-&gt;rep_set_priority</a></b><ul compact><li>The <a href="../../api_c/rep_priority.html">DB_ENV-&gt;rep_set_priority</a> method configures the local site's priority for
the purpose of elections.</ul>
<b><a href="../../api_c/rep_timeout.html">DB_ENV-&gt;rep_set_timeout</a></b><ul compact><li>This method optionally configures various timeout values.  Otherwise
default timeout values as specified in <a href="../../api_c/rep_timeout.html">DB_ENV-&gt;rep_set_timeout</a> are
used.</ul>
<b><a href="../../api_c/rep_limit.html">DB_ENV-&gt;rep_set_limit</a></b><ul compact><li>The <a href="../../api_c/rep_limit.html">DB_ENV-&gt;rep_set_limit</a> method imposes an upper bound on the amount of data
that will be sent in response to a single call to <a href="../../api_c/rep_message.html">DB_ENV-&gt;rep_process_message</a>.
During client recovery, that is, when a replica site is trying to
synchronize with the master, clients may ask the master for a large
number of log records.  If it is going to harm an application for the
master message loop to remain busy for an extended period transmitting
records to the replica, then the application will want to use
<a href="../../api_c/rep_limit.html">DB_ENV-&gt;rep_set_limit</a> to limit the amount of data the master will send
before relinquishing control and accepting other messages.</ul>
<b><a href="../../api_c/rep_request.html">DB_ENV-&gt;rep_set_request</a></b><ul compact><li>This method sets a threshold for the minimum and maximum time that
a client waits before requesting retransmission of a missing
message.</ul>
<br>
<p>In addition to the methods previously described, applications which use
the Base replication API may also call the following methods, as needed:
<a href="../../api_c/rep_stat.html">DB_ENV-&gt;rep_stat</a>, <a href="../../api_c/rep_sync.html">DB_ENV-&gt;rep_sync</a>, <a href="../../api_c/rep_config.html">DB_ENV-&gt;rep_set_config</a>.</p>
<table width="100%"><tr><td><br></td><td align=right><a href="../rep/mgr_meth.html"><img src="../../images/prev.gif" alt="Prev"></a><a href="../toc.html"><img src="../../images/ref.gif" alt="Ref"></a><a href="../rep/comm.html"><img src="../../images/next.gif" alt="Next"></a>
</td></tr></table>
<p><font size=1>Copyright (c) 1996,2008 Oracle.  All rights reserved.</font>
</body>
</html>
